Create Customer Zone

This API is used to create a new customer-defined (user-defined) zone.

HTTP URL
POST	/api/v2/customer/{id}/zone

Eligibility

The Requester is eligible to create a new zone for its own use. The Requester is not eligible to create a new zone at any other customer level, including its own sub-accounts.

API Request

Request Structure

Element	Type	M/O/CM	Description
name	String	M	Customer’s (user-defined) zone name
description	String	O	Customer’s (user-defined) zone description. It is highly recommended to provide a meaningful description.
countryCode	String	M	ISO alpha-3 Country Code
plmn	String	M	Public Land Mobile Network. MCCMNC representation

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
requestId	UUID	M	Request instance ID. To be used by external systems to query the call (operation) status: In progress Successful Failed
zoneId	UUID	M	New zone ID generated universally unique identifier

Element

Type

M/O/CM

Description

requestId

UUID

Request instance ID.

To be used by external systems to query the call (operation) status:

In progress
Successful
Failed

zoneId

UUID

New zone ID generated universally unique identifier

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again

Examples

Request Body

Copy

{
  "name": "Canada North",
  "description": "Canada north regions",
  "countryCode": "CAN",
  "plmn": [
    "CANTS",
    "CANBM"
  ] 
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370",
      "zoneId": "e7fcef24-5c03-41dd-9e33-995b7d6f32b1",
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy

{
  "errorCode": "GLOBAL_1001",
  "errorMessage": "Service unavailable. Please try again",
  "content": "",
  "pageable": ""
}